docs(readme): fix broken evals link#900
Open
santhiprakash wants to merge 1 commit into
Open
Conversation
Problem: README.md links to evals/README.md, which does not exist. Fix: point the 'our evals' link to evals/buffbench/README.md, the existing evaluation documentation. Verification: confirmed with a local markdown link scan that only the evals/README.md link is broken, and 'ls -l evals/buffbench/README.md' confirms the target exists.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem\n\nREADME.md links to
evals/README.mdon line 13, but that file does not exist. Clicking the "our evals" link from the rendered README results in a 404.\n\n## Triage / Root cause\n\nPR #255 ([chore] Update readmes) introduced the[our evals](evals/README.md)link, but the target file was never present in the public tree. The actual evaluation documentation lives atevals/buffbench/README.md.\n\n## Fix\n\nUpdate the link target fromevals/README.mdtoevals/buffbench/README.md. This is the minimal, existing doc that describes the BuffBench evaluation framework referenced by the 61% vs 53% comparison.\n\n## Verification\n\n-python3markdown link scan ofREADME.md,CONTRIBUTING.md, anddocs/**/*.md*confirmedevals/README.mdis the only missing relative link.\n-ls -l evals/buffbench/README.mdconfirms the new target exists and documents the evaluation framework.\n-python3 ../scripts/preflight_ship.py --repo CodebuffAI/codebuff --local codebuff --branch main --file README.md --must-contain '[our evals](evals/README.md)' --search 'evals/README.md in:title,body'passed, confirming the bug marker is still on upstream/main and no open duplicate PR exists.\n\n## Notes / Risks\n\nNo code changes. Only the README link is updated, so there is no risk to runtime behavior. The PR title and commit follow the repo's existingdocs(scope): ...convention.